Skip to content

fix a11y breadcrumb #465

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

fix a11y breadcrumb #465

wants to merge 2 commits into from

Conversation

cedric07
Copy link
Contributor

@cedric07 cedric07 commented Jun 16, 2025 •
edited by sourcery-ai bot
Loading

Fix du breadcrumb yoast pour ajouter une structure liste ordonnée au lieu des <span> + inclure le séparateur à l'intérieur des <li> car sinon il se trouve entre chaque <li>

On perd donc la main sur la configuration du séparateur en BO, mais pas gênant.

Summary by Sourcery

Introduce an accessibility-focused Breadcrumb service that replaces the default Yoast breadcrumb spans with semantic list markup and hides separators within list items.

New Features:

  • Add Breadcrumb service to override Yoast SEO breadcrumb output for accessibility

Enhancements:

  • Render breadcrumbs as an ordered list (
      ) with list items (
    1. )
    2. Include the separator inside each
    3. with aria-hidden attribute
    4. Remove the default external breadcrumb separator

Chores:

  • Register the new Breadcrumb service in the Framework bootstrap

@sourcery-ai Sourcery AI
Copy link

sourcery-ai bot commented Jun 16, 2025 •
edited
Loading

Reviewer's Guide

Introduces a Breadcrumb service to overhaul Yoast SEO breadcrumbs for accessibility, outputting them as an ordered list with separators inside the list items and disabling the external separator, and registers this service in the theme’s framework.

Sequence diagram for Yoast breadcrumb rendering with new Breadcrumb service

sequenceDiagram
    participant YoastSEO as Yoast SEO
    participant Breadcrumb as Breadcrumb Service
    participant Theme as Theme
    YoastSEO->>Breadcrumb: apply 'wpseo_breadcrumb_output_wrapper' filter
    YoastSEO->>Breadcrumb: apply 'wpseo_breadcrumb_single_link_wrapper' filter
    YoastSEO->>Breadcrumb: apply 'wpseo_breadcrumb_single_link' filter
    YoastSEO->>Breadcrumb: apply 'wpseo_breadcrumb_separator' filter
    Breadcrumb-->>YoastSEO: returns modified wrappers and separator
    YoastSEO-->>Theme: outputs accessible breadcrumb as <ol><li>...</li></ol> with separator inside <li>
Loading

File-Level Changes

Change Details Files
Created a new Breadcrumb service to override Yoast breadcrumb markup and accessibility
  • Implemented Service interface with register() and boot()
  • Hooked four wpseo_breadcrumb filters in boot()
  • Replaced wrapper tags to
      and
    1. via filter callbacks
    2. Injected separator inside
    3. for non-last items and removed external separators
 inc/Services/Breadcrumb.php
Registered the Breadcrumb service in the framework initialization
  • Imported Breadcrumb class in Framework.php
  • Added Breadcrumb::class to the services array
 inc/Framework.php
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

sourcery-ai[bot]
sourcery-ai bot reviewed Jun 16, 2025
View reviewed changes
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @cedric07 - I've reviewed your changes and they look great!

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@cedric07